Skip to content

fix(stepfunctions): lambda invoke grant all versions #34398

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

Y-JayKim
Copy link
Contributor

@Y-JayKim Y-JayKim commented May 8, 2025

Issue # (if applicable)

Closes #17515 .

Reason for this change

AWS CDK-generated Step Function roles break in-flight Step Function executions when using versioned Lambda functions. During deployment, the Step Function’s IAM role is updated to include permissions for the new Lambda version but removes permissions for the previous version. This causes lambda:InvokeFunction permission failures in in-flight executions that were started before the deployment and are still trying to invoke the previous Lambda version.

This issue is particularly problematic when using Step Function Aliases with deployment preferences for traffic shaping, as a percentage of new executions are directed to the previous version of the state machine, which attempts to invoke a Lambda version it no longer has permissions for.

Description of changes

Implemented a feature flag STEPFUNCTIONS_TASKS_LAMBDA_INVOKE_GRANT_ALL_VERSIONS to control IAM permissions granted when using Lambda versions with Step Functions:

Added a new feature flag in cx-api/lib/features.ts with detailed documentation
Modified LambdaInvoke task implementation to check for this flag:
When enabled: grants permissions to both the specific Lambda version AND all versions using a wildcard pattern (function-arn:*)
When disabled (default behavior): maintains current behavior of granting permission only to the specific version
Updated API documentation to clearly explain the feature flag usage
Updated the README.md to include examples showing how to enable the feature flag
This approach maintains backward compatibility while giving users an opt-in solution to prevent in-flight executions from failing during deployments.

Describe any new or updated permissions being added

When the feature flag is enabled, the Step Function's IAM role will now include an additional IAM permission that grants access to all versions of the Lambda function using a wildcard pattern, e.g.:

  • Before: "Resource": ["arn:aws:lambda:region:account:function:name:version"]
  • After: "Resource": ["arn:aws:lambda:region:account:function:name:version", "arn:aws:lambda:region:account:function:name:*"]

Description of how you validated changes

  • Added comprehensive unit tests that verify both behaviors (with feature flag enabled and disabled)
  • Updated integration tests to demonstrate both scenarios with and without the feature flag
  • Created test suites to verify behavior with both versioned Lambda functions and non-versioned Lambda functions

Checklist


By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license

@aws-cdk-automation aws-cdk-automation requested a review from a team May 8, 2025 22:06
@github-actions github-actions bot added bug This issue is a bug. effort/small Small work item – less than a day of effort p2 labels May 8, 2025
@mergify mergify bot added the contribution/core This is a PR that came from AWS. label May 8, 2025
@GavinZZ GavinZZ added pr/do-not-merge This PR should not be merged at this time. needs-security-review Related to feature or issues that needs security review labels May 12, 2025
@GavinZZ
Copy link
Contributor

GavinZZ commented May 12, 2025

Adding a do-not-merge and needs-security-review labels to wait on an update from security review on this approach.

@Y-JayKim Y-JayKim force-pushed the fix/stepfunction-allversion-permission branch from 11ed8dd to f8252a2 Compare May 20, 2025 22:19
@Y-JayKim Y-JayKim removed the pr/do-not-merge This PR should not be merged at this time. label May 20, 2025
@samson-keung samson-keung assigned samson-keung and unassigned GavinZZ May 22, 2025
const functionArn = this.props.lambdaFunction.functionArn;
let resources: string[];
if (grantAllVersions) {
const baseArn = functionArn.replace(/:[^:]*$/, '');
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

functionArn could be a token I believe. So calling .replace on token will not work.

Maybe the resourceArnsForGrantInvoke can be used instead, or the grantInvoke method. Please verify as I haven't dived super deep on this.

throw new Error('Expected IAM policy to include ":*" permission for all Lambda versions');
}

app.synth();
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
app.synth();

This is no longer needed. It can create feature flag problems. The integ test is failing probably due to this.

(More context: I think some integ tests have this as it is the old way of writing the test before integ-runner was a thing.)

@@ -150,9 +151,22 @@ export class LambdaInvoke extends sfn.TaskStateBase {
},
};

const grantAllVersions = cdk.FeatureFlags.of(this).isEnabled(cxapi.STEPFUNCTIONS_TASKS_LAMBDA_INVOKE_GRANT_ALL_VERSIONS);
const functionArn = this.props.lambdaFunction.functionArn;
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should update the doc for the lambdaFunction property and call out what behaviour to expect when using the property and the feature flag. By doc, I mean this: https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_stepfunctions_tasks.LambdaInvoke.html#lambdafunction

In particular, I think we should call out that in XYZ configuration, even if user pass specific version to LambdaInvoke the permission will include ALL versions.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

updated with the new commit

This ensures that in-flight executions continue to work even after deploying updates to Lambda functions.
`,
introducedIn: { v2: 'V2NEXT' },
recommendedValue: true,
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This means that when users do cdk init, the project will have this feature flag as true by default (without consciously opting into it). Can you confirm this is your intention and security review is fine with this behaviour?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This has been discussed with security and it has been confirmed.

@aws-cdk-automation
Copy link
Collaborator

AWS CodeBuild CI Report

  • CodeBuild project: AutoBuildv2Project1C6BFA3F-wQm2hXv2jqQv
  • Commit ID: c80ec19
  • Result: FAILED
  • Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug This issue is a bug. contribution/core This is a PR that came from AWS. effort/small Small work item – less than a day of effort needs-security-review Related to feature or issues that needs security review p2
Projects
None yet
Development

Successfully merging this pull request may close these issues.

(stepfunctions): CDK generated stepfunction roles breaking inflight stepfunction executions with versioned lambdas
4 participants